/*-----------------------------------------------------------------------------
	The contents of this file are subject to the Mozilla Public License
	Version 1.1 (the "License"); you may not use this file except in
	compliance with the License. You may obtain a copy of the License at
	http://www.mozilla.org/MPL/
	
	Software distributed under the License is distributed on an "AS IS"
	basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
	License for the specific language governing rights and limitations
	under the License.
	
	The Original Code is Fever Framework code.
	
	The Initial Developer of the Original Code is Romain Ecarnot.
	Portions created by Initial Developer are Copyright (C) 2006
	the Initial Developer. All Rights Reserved.
	
	Contributor(s):
	
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
-----------------------------------------------------------------------------*/

import fever.exception.IllegalAccessException;
import fever.utils.Stringifier;

/**
 * Abstract class defines basic formatting rules for concrete formatter classes.
 *
 * @author Romain Ecarnot
 */
class fever.data.formatter.Formatter
{
	//-------------------------------------------------------------------------
	// Public Properties
	//-------------------------------------------------------------------------
	
	/** Error message (if any). */
	public var error : String;
		
	
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
	
	/**
	 * Formats passed-in {@code value} and returns formatting string result.
	 * 
	 * @throws IllegalAccessException if method is not overrided by subclass.
	 */
	public function format( value ) : String
	{
		throw new IllegalAccessException( 'must be override' );
		return null;	
	}
	
	/**
	 * Returns string representation.
	 */
	public function toString() : String
	{
		return Stringifier.parse( this );
	}
	
	
	//-------------------------------------------------------------------------
	// Private implementation
	//-------------------------------------------------------------------------
	
	/**
	 * Constructs a new {@link Formatter} instance.
	 */
	private function Formatter()
	{
		error = '';
	}
	
	private function _formatNumber( value : Number ) : String
	{
   		return (value > 9) ? String(value) : ( '0' + value );
	}
	
}